/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * This file is part of retabel.
 *
 * Copyright (c) 2011 by individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution
 * for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.retabel.service.failover;

import javax.ejb.Local;

/**
 * Interface to access the failover mechanism. In case of a process failure the initial process parameters are
 * persisted. It's possible to restart the process with the stored parameters, for example in case if a remote
 * system is temporarily not reachable.
 * <p/>
 * <h3>Extra-Info</h3>
 * Created: 23:06 21.09.11
 *
 * @author Burt Parkers
 * @version 1.0
 */
@Local
public interface FailoverService {

    /**
     * Stores the process parameters and the class name of the parameter into the failure table.
     *
     * @param failable the parameter object.
     * @param className the class name.
     */
    void failover(Failable failable, String className);

    /**
     * Restarts a specific failed process, independent of the redo parameters.
     *
     * @param id the specific failure entry.
     */
    void redo(int id);

    /**
     * Restarts all processes with redo date older than a specific date.
     */
    void redo();
}
